Platform Explorer / Nuxeo Platform 2023.9

Operation LocalConfiguration.SetSimpleConfigurationParameterAsVar (Set Context Variable From a Simple Configuration Parameter)

Description

Set a context variable that points to the value of the given parameter name in the SimpleConfiguration from the input Document. You must give a name for the variable.
Operation id LocalConfiguration.SetSimpleConfigurationParameterAsVar
Category Local Configuration
Label Set Context Variable From a Simple Configuration Parameter
Requires
Since

Parameters

Name Description Type Required Default value
name string yes  
parameterName string yes  
defaultValue string no  

Signature

Inputs document
Outputs document

Implementation Information

Implementation Class Class: org.nuxeo.ecm.localconf.SetSimpleConfParamVar
Contributing Component org.nuxeo.ecm.localconf.operations

JSON Definition

{
  "id" : "LocalConfiguration.SetSimpleConfigurationParameterAsVar",
  "label" : "Set Context Variable From a Simple Configuration Parameter",
  "category" : "Local Configuration",
  "requires" : null,
  "description" : "Set a context variable that points to the value of the given parameter name in the SimpleConfiguration from the input Document. You must give a name for the variable.",
  "url" : "LocalConfiguration.SetSimpleConfigurationParameterAsVar",
  "signature" : [ "document", "document" ],
  "params" : [ {
    "name" : "name",
    "description" : null,
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "parameterName",
    "description" : null,
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "defaultValue",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}